home *** CD-ROM | disk | FTP | other *** search
/ Aminet 48 / Aminet 48 (2002)(GTI - Schatztruhe)[!][Apr 2002].iso / Aminet / text / edit / vim60rt.lha / Vim / vim60 / doc / pi_expl.txt < prev    next >
Encoding:
Text File  |  2001-09-26  |  8.7 KB  |  199 lines
  1. *pi_expl.txt*   For Vim version 6.0.  Last change: 2001 Sep 17
  2.  
  3.  
  4.           VIM REFERENCE MANUAL    by M A Aziz Ahmed
  5.                       updated by Mark Waggoner
  6.  
  7.  
  8.                         *file-explorer* *file-browser*
  9. Plugin for exploring (or browsing) directories and files
  10.  
  11. 1. Starting the file explorer        |expl-starting|
  12.  
  13. The functionality mentioned here is a |standard-plugin|.
  14. This plugin is only available if 'compatible' is not set.
  15. You can avoid loading this plugin by setting the "loaded_explorer" variable: >
  16.     :let loaded_explorer = 1
  17.  
  18. {Vi does not have any of this}
  19.  
  20. ==============================================================================
  21. 1. Starting the file explorer                *expl-starting*
  22.  
  23. This plugin is used to explore directories inside Vim. The file explorer is
  24. launched whenever the user tries to edit a directory.
  25.                         *:Explore* *:Sexplore*
  26. To launch the explorer in the directory of the file currently edited: >
  27.     :Explore
  28. If the file has changes the window is split.  To always split the window: >
  29.     :Sexplore
  30. To launch the explorer in a specific directory: >
  31.     :Explore dirname
  32.     :Sexplore dirname
  33.  
  34. From inside the explorer move your cursor to a line containing a file or
  35. directory name.  The following command keys are available:
  36.  
  37.   <enter> will open the file in the window the explorer is currently
  38.       occupying.
  39.   'o' will split a new window and open the file in the new window.
  40.   'O' will open the file chosen using the window that the cursor was in just
  41.       before you started or entered the explorer window.  If the explorer is
  42.       the only window, it will first split a new window to use for the file to
  43.       be opened.
  44.   'p' will open (or use) the preview window showing the file
  45.  
  46. When splitting off a new window, you can control where the split window will
  47. go relative to the explorer window using the variables g:explVertical,
  48. g:explSplitBelow and g:explSplitRight.
  49.  
  50.                             *g:explVertical*
  51.                             *g:explSplitBelow*
  52.                             *g:explSplitRight*
  53.                             *g:explStartBelow*
  54.                             *g:explStartRight*
  55. To control whether the split is made horizontally or vertically, use: >
  56.   let g:explVertical=1    " Split vertically
  57.   let g:explVertical=0    " Split horizontally (default)
  58.  
  59. To control where the window goes relative to the explorer window when
  60. splitting horizontally, use the variable: >
  61.   let g:explSplitBelow=1    " Put new window below explorer window
  62.   let g:explSplitBelow=0    " Put new window above explorer window
  63. The default for this is the setting of splitbelow at the time the plugin is
  64. loaded.
  65.  
  66. To control where the windows goes relative to the explorer window when
  67. splitting vertically, use the variable: >
  68.   let g:explSplitRight=1    " Put new window to the right of the explorer
  69.   let g:explSplitRight=0    " Put new window to the left of the explorer
  70. The default for this is the setting of splitright at the time the plugin is
  71. loaded.
  72.  
  73. To use a different split method for the explorer window, use: >
  74.   let g:explStartRight=1    " Put new explorer window to the right of the
  75.                 " current window
  76.   let g:explStartRight=0    " Put new explorer window to the left of the
  77.                 " current window
  78. The default for this set to g:explSplitRight at the time the plugin is loaded.
  79.  
  80. To use a different split method for the explorer window, use: >
  81.   let g:explStartBelow=1    " Put new explorer window below the
  82.                 " current window
  83.   let g:explStartBelow=0    " Put new explorer window above the
  84.                 " current window
  85. The default for this set to g:explSplitBelow at the time the plugin is loaded.
  86.  
  87. The start splits allow for the explorer window to be placed in a file browser
  88. type arrangement, where the directories are shown on the left and the contents
  89. opened on the right.  The start split settings are only used when issueing
  90. the Sexplore command.
  91.  
  92. Note that the window split is done a little bit differently than window splits
  93. are usually done.  Ordinarily, when splitting a window, the space occupied by
  94. the current window will be split to give space for the new window.  The
  95. explorer attempts to instead split from a window adjacent to the explorer
  96. window so that the explorer window will not change sizes.  If there is not an
  97. adjacent window in the direction you are splitting, the explorer window is
  98. split.
  99.  
  100.                             *g:explWinSize*
  101. After opening a file with the 'o' command, you might want to resize the
  102. explorer window. This can be done by setting the variable >
  103.   let g:explWinSize=N
  104. N is the number of rows (when the window is split horizontally) or the number
  105. of columns (when the window is split vertically).  If g:explWinSize is set to
  106. an empty string (""), resizing will not be done.  g:explWinSize defaults to
  107. 15.
  108.  
  109.                             *g:explDetailedList*
  110. The file size (in bytes) and modification time can be displayed inside the
  111. file explorer window. By pressing 'i', you can toggle between the name only
  112. display and the more lengthy display.  If you want the size and date to show
  113. by default, use >
  114.   let g:explDetailedList=1
  115. Doing this may slightly slow down explorer. The difference may or may not be
  116. noticeable depending on your system and whether the directory is local or on
  117. the network and on the size of the directory.
  118.  
  119.                             *g:explDateFormat*
  120. The format of date displayed is configurable using the variable
  121. g:explDateFormat.  explorer uses this variable to pass to strftime() to fetch
  122. the date information. |strftime()|  The default is >
  123.   let g:explDateFormat="%d %b %Y %H:%M"
  124.  
  125. Note that for sorting purposes, the date is always placed at the end of the
  126. line in its 'raw' form.  If you have syntax highlighting turned on, this raw
  127. date should be invisible.
  128.  
  129.                             *g:explHideFiles*
  130. You can hide some files by filling the variable g:explHidFiles with regular
  131. expressions. A filename that matches any of these regular expressions will not
  132. be shown. For example, >
  133.  
  134.   let g:explHideFiles='^\.,\.gz$,\.exe$,\.zip$'
  135.  
  136. will not show files that begin with "." and those that end in .gz, .exe or
  137. .zip. However, all directory names will always be shown. If while exploring,
  138. you'd like to see the hidden files as well, use the command "a".
  139. The explorer header will indicate if filtering is being done.
  140.  
  141.                             *g:explDetailedHelp*
  142. The help information spanning a few lines can be turned off (and just a single
  143. help message enabled) using the option >
  144.   let g:explDetailedHelp=0
  145. You can anytime switch to the detailed help format by pressing ?.
  146.  
  147.                             *explorer-delete*
  148. Pressing 'D' inside explorer deletes the file under the cursor. You can delete
  149. many files by visually selecting them and using 'D'. The deletion is
  150. interactive in the form y/n/a/q. Directory deletion is not supported (mainly
  151. because there is no way to delete a directory using a vim built-in function).
  152.  
  153.                             *explorer-rename*
  154. Pressing 'R' inside explorer will allow you to rename the file under the
  155. cursor.
  156.  
  157.                             *g:explSortBy*
  158. The display in the file explorer can be sorted in forward or reverse order by
  159. name, size, or modification date.  You can set the default sorting direction
  160. with the option >
  161.   let g:explSortBy='name'        " alphabetically
  162.   let g:explSortBy='reverse name'    " reverse alphabetically
  163.   let g:explSortBy='date'        " newest first
  164.   let g:explSortBy='reverse date'    " oldest first
  165.   let g:explSortBy='size'        " largest first
  166.   let g:explSortBy='reverse size'       " smallest first
  167. While in the explorer, you can rotate through the sort fields by pressing the
  168. 's' key and you can reverse the current sort order by pressing the 'r' key.
  169. Sorting on fields other than the name will be faster if the size and date are
  170. displayed (using 'i' or g:explDetailedList).
  171. The explorer heading will indicate the current sort order.
  172.  
  173.                             *g:explDirsFirst*
  174. To control the segregation of directories and files, you can set this option >
  175.   let g:explDirsFirst=1     " Directories at the top of the list (default)
  176.   let g:explDirsFirst=0     " Directories mixed in with files
  177.   let g:explDirsFirst=-1    " Directories at the bottom of the list
  178.  
  179.                             *g:explSuffixesLast*
  180. To control the segregation of files matching the suffixes option, you can set
  181. this option >
  182.   let g:explSuffixesLast=1     " Files matching suffixes sorted at the bottom
  183.                    " of the list (default)
  184.   let g:explSuffixesLast=0     " Files matching suffixes sorted normally
  185.   let g:explSuffixesLast=-1    " Files matching suffixes sorted at the top of
  186.                    " the list
  187. The heading will indicate if suffixes have been moved to the end (or start) of
  188. the list.
  189.  
  190.                             *g:explUseSeparators*
  191. Directories and files matching the suffixes list will be highlighted.  If you
  192. have the directories, files, and suffixes separated, and you would like a
  193. separator line between the groups, you can set the option >
  194.   let g:explUseSeparators=1    " Use separator lines
  195.   let g:explUseSeparators=0    " Don't use separator lines
  196.  
  197. ==============================================================================
  198.  vim:tw=78:noet:ts=8:ft=help:norl:
  199.